Hybris UX Api
GET billingAccount by ID (Debt Check)
It retrieves the billing account details based on Id.
This API is implemented for JM, PA and CR markets.
Request
URL
https://[localhost]:[port]/ecom-ux/v1/{businessId}/billingAccount/{id}URI PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | String | 2 letter ISO 3166 country code (PR, JM, PA, etc.) identifying the business unit. | Y |
| Id | String | Identifier of the billingAccount | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client-id | string | The client-id identifying the channel. Minimum characters: 5 | Y |
| client-secret | string | Password associated with the client-id. Minimum characters: 5 | Y |
| Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N |
| channeId | string | Channel to business: Can be: “ecom" | N |
| lob | string | The Line of Business Identifier currently available are: FIXED enum: ["FIXED", "PREPAID", "POSTPAID"] | N |
Responses
Response for CR
[
{
"id": "855651",
"name": "YORLENI ALEJANDRA CASTILLO CORDERO",
"@type": "BillingAccount",
"state": "Active",
"accountBalance": [
{
"amount": {
"unit": "CRC",
"value": 185346
},
"balanceType": "CABLE TICA"
},
{
"amount": {
"unit": "CRC",
"value": 61377
},
"balanceType": "INTERNET"
},
{
"amount": {
"unit": "CRC",
"value": 246723
},
"balanceType": "AccountBalance"
}
],
"contact": [
{
"contactName": "YORLENI ALEJANDRA CASTILLO CORDERO",
"contactMedium": [
{
"mediumType": "Address",
"characteristic": {
"contactType": "BillingAddress",
"stateOrProvince": "SAN JOSE",
"city": "SAN JOSE",
"street1": "HATILLO 8",
"street2": "HATILLO"
}
}
]
}
],
"relatedParty": [
{
"id": "1-101T72F",
"name": "YORLENI ALEJANDRA CASTILLO CORDERO",
"role": "Customer",
"@referredType": "Individual"
}
]
}
]Request for JM
http://[localhost]:[port]/ecom-ux/v1/JM/billingAccount/101002090000Response for Liberate JM Debt check using Id. Fields which are part of this example are only in scope for JM Debt check response.
{
"id": "860019440000",
"billable": true,
"accountType": "R",
"description": "Residence",
"name": "MRS D Cohen",
"paymentStatus": "In Arrears",
"state": "W-Working",
"accountBalance": [
{
"amount": {
"value": 2313.53,
"unit": "JMD"
},
"balanceType": "NetPayable"
},
{
"amount": {
"value": 2649.66,
"unit": "JMD"
},
"balanceType": "LastBillAmount",
"validFor": {
"endDateTime": "2022-03-23T00:00:00.000Z"
}
},
{
"amount": {
"value": 2000.00,
"unit": "JMD"
},
"balanceType": "LastPayment Amount",
"validFor": {
"endDateTime": "2022-02-25T00:00:00.000Z"
}
},
{
"amount": {
"value": 2313.53,
"unit": "JMD"
},
"balanceType": "Overdue Amount"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "DepositRequired"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "WrittenOffAmount"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "TotalQuery"
},
{
"amount": {
"value": 2313.53,
"unit": "JMD"
},
"balanceType": "TotalOutstandingBalance"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "DepositHeld"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "Total Query Tax"
}
],
"billStructure": {
"cycleSpecification": {
"id": "C"
},
"presentationMedia": [
{
"id": "E",
"name": "Electronic Bills"
}
]
},
"paymentPlan": [
{
"priority": 0,
"planType": "T"
}
],
"relatedParty": [
{
"id": "101804393",
"name": "MRS D Cohen",
"role": "customer"
},
{
"id": "990000",
"name": "Residential",
"role": "marketingCategory"
}
],
"contact": [
{
"contactMedium": [
{
"mediumType": "BillingAddress",
"characteristic": {
"street1": "20 EBONY GLADE",
"city": "KGN 8"
}
},
{
"mediumType": "Email",
"characteristic": {
"emailAddress": "enosworthy_cohen@hotmail.com"
}
}
]
},
{
"contactName": "Mrs D. Cohen",
"partyRoleType": "EMPL",
"contactMedium": [
{
"mediumType": "Telephone",
"characteristic": {
"phoneNumber": "8763280469"
}
}
]
}
],
"creditLimit": {
"unit": "JMD",
"value": 0
},
"defaultPaymentMethod": {
"id": "F",
"name": "Cash"
}
}Response for Cerillion JM Debt check using Id. Fields which are part of this example are only in scope for JM Debt check response.
{
"id": "50380292",
"href": "https://esb-test.lla.com/tmf-api/accountManagement/v1/JM/billingAccount/50380292",
"name": "SHANI MATTHEWS RICHARDS",
"state": "SN",
"relatedParty": [
{
"@referredType": "Customer",
"id": "221824"
}
],
"accountType": "RES",
"billStructure": {
"presentationMedia": [
{
"id": "E",
"name": "EMAIL"
}
]
},
"contact": [
{
"contactName": "RICHARDS, SHANI, MATTHEWS",
"contactType": "primary",
"contactMedium": [
{
"mediumType": "BillingAddress",
"characteristic": {
"street2": "MARSHALL CRESCENT",
"city": "MAY DAY",
"stateOrProvince": "MANDEVILLE",
"country": "Jamaica",
"postCode": "00000"
}
},
{
"mediumType": "Telephone",
"characteristic": {
"contactType": "MOBILE_NO",
"phoneNumber": "8768997865"
}
},
{
"mediumType": "Email",
"characteristic": {
"emailAddress": "rochellmatthews14@gmail.com"
}
}
]
}
],
"accountBalance": [
{
"amount": {
"unit": "JMD",
"value": 8000.0
},
"balanceType": "LastPaymentAmount",
"validFor": {
"endDateTime": "2022-01-19T12:52:31.000Z"
}
},
{
"amount": {
"unit": "JMD",
"value": 16862.05
},
"balanceType": "CurrentBalance"
},
{
"amount": {
"unit": "JMD",
"value": 16862.05
},
"balanceType": "OverdueBalance"
},
{
"amount": {
"unit": "JMD",
"value": 0.0
},
"balanceType": "WrittenOffAmount"
},
{
"amount": {
"unit": "JMD",
"value": 16862.05
},
"balanceType": "TotalOutstandingBalance"
},
{
"amount": {
"unit": "JMD",
"value": 16862.05
},
"balanceType": "LastBillAmount",
"validFor": {
"endDateTime": "2022-03-12T00:00:00.000Z"
}
}
],
"paymentStatus": "In Arrears"
}Request for PA
http://[localhost]:[port]/ecom-ux/v1/PA/billingAccount/101002090000Response for PA billingAccountById. Fields which are part of this example are only in scope for PA Debt check response.
{
"id": "101002090000",
"billable": true,
"accountType": "R",
"description": "Residencial",
"name": "Maria Santiago Amaya CedeÑo",
"paymentStatus": "In Arrears",
"state": "T-TFS",
"accountBalance": [
{
"amount": {
"value": 39.50,
"unit": "PAB"
},
"balanceType": "NetPayable"
},
{
"amount": {
"value": 1.54,
"unit": "PAB"
},
"balanceType": "LastBillAmount",
"validFor": {
"endDateTime": "2022-07-01T00:00:00.000Z"
}
},
{
"amount": {
"value": 42.69,
"unit": "PAB"
},
"balanceType": "LastPayment Amount",
"validFor": {
"endDateTime": "2022-04-21T11:20:00.000Z"
}
},
{
"amount": {
"value": 39.50,
"unit": "PAB"
},
"balanceType": "Overdue Amount"
},
{
"amount": {
"value": 0.00,
"unit": "PAB"
},
"balanceType": "DepositRequired"
},
{
"amount": {
"value": 0.00,
"unit": "PAB"
},
"balanceType": "WrittenOffAmount"
},
{
"amount": {
"value": 0.00,
"unit": "PAB"
},
"balanceType": "TotalQuery"
},
{
"amount": {
"value": 39.50,
"unit": "PAB"
},
"balanceType": "TotalOutstandingBalance"
},
{
"amount": {
"value": 0.00,
"unit": "PAB"
},
"balanceType": "DepositHeld"
},
{
"amount": {
"value": 0.00,
"unit": "PAB"
},
"balanceType": "Total Query Tax"
}
],
"billStructure": {
"cycleSpecification": {
"id": "D"
},
"presentationMedia": [
{
"id": "N",
"name": "Non-paper Based Bill"
}
]
},
"paymentPlan": [
{
"priority": 0
}
],
"relatedParty": [
{
"id": "7-52-701",
"name": "Maria Santiago Amaya CedeÑo",
"role": "customer"
},
{
"id": "990005",
"name": "RESI_BRONCE",
"role": "marketingCategory"
}
],
"contact": [
{
"contactMedium": [
{
"mediumType": "BillingAddress",
"characteristic": {
"street1": "PANAMA SAN MIGUELITO RUFINA",
"street2": "ALFARO BDA VILLA LUCRE CASA G",
"city": "RUTA 1 *",
"stateOrProvince": "CASA 677 D PASEO DEL VALLE"
}
}
]
},
{
"contactName": "MARIA AMAYA",
"partyRoleType": "OWNER",
"contactMedium": []
},
{
"contactName": "Maria",
"partyRoleType": "OWNER",
"contactMedium": [
{
"mediumType": "Telephone",
"characteristic": {
"phoneNumber": "66907760"
}
}
]
}
],
"creditLimit": {
"unit": "PAB",
"value": 0.00
},
"defaultPaymentMethod": {
"id": "C",
"name": "Cash"
}
}Definitions
Each of the response parameters are detailed.
| Field name | Datatype | Description | required |
|---|---|---|---|
| id | string | Unique identifier of the account | Y |
| href | string | Unique reference of the account | N |
| accountType | string | For liberate, A Cellular Pre-paid,B Business,C Co-owned Station,D Diplomat,E Employee,F CO-owned residential,G Government,H Hospital,I Internet,J Cellular Business,K International Bus,L Cell Maj acct (res),M Corporate Account,N Cellular Corporate,O Browse & Talk HFONE,P PBX & Key System,Q CWJ CONTRACTORS + CU,R Residence,S Pensioner,T Cellular Residential,U Prepaid Home Fone,V Non-Pots Customer,W International Custom,X Carrier Services,Y Mobile New Service,Z Cell VIP/Diplomat. For cerillion RES or BUS. | N |
| description | string | Detailed description of the party account | N |
| lastModified | datetime | Date of last modification of the account | N |
| name | string | Name of the account | N |
| paymentStatus | string | The condition of the account, such as In Arrears, Active | N |
| billable | boolean | Indicates Account is billable or not | |
| ratingType | string | Indicates whether the account follows a specific payment option such as prepaid or postpaid | N |
| state | string | Contains the lifecycle state. For cerillion, common values are SN (status normal), SF (status final), SW (status Written Off). For liberate, Liberate: A-Allocated but not yet active, B-Call Barred, C-Ceased D-In default but not on TOS, E-Written off F-Closed, O-Debt Outsource, P-In default but promise topay, S-Recommended for cessation, T-TOS'ed W-Working | N |
| accountBalance | object Array | Balances linked to the account | N |
| accountBalance.balanceType | string | Type of balances ; NetPayable, LastBillAmount, LastPayment Amount/LastPaymentAmount, Overdue Amount, OverdueBalance, DepositRequired, WrittenOffAmount, TotalQuery, TotalOutstandingBalance, DepositHeld, Total Query Tax, CurrentBalance, . | N |
| accountBalance.amount | object | Balance amount | N |
| accountBalance.amount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| accountBalance.amount.value | number, float | A positive floating point number | N |
| accountBalance.validFor | object | 'A period of time, either as a deadline (endDateTime only) a startDateTime only, or both | N |
| accountBalance.validFor.endDateTime | datetime | End of the time period, using IETC-RFC-3339 format. Eg: 2021-10-05T04:54:11 | N |
| accountBalance.validFor.startDateTime | datetime | Start of the time period, using IETC-RFC-3339 format. NA for JM. | N |
| accountBalance.@baseType | string | When sub-classing, this defines the super-class | N |
| accountBalance.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| accountBalance.@type | string | When sub-classing, this defines the sub-class entity name | N |
| accountRelationship | object Array | Significant connection between accounts. For instance an aggregating account for a list of shop branches each having its own billing account | N |
| accountRelationship.relationshipType | string | Type of relationship. | N |
| accountRelationship.account | object | .An account may be a party account or a financial account. | N |
| accountRelationship.account.id | string | Unique identifier Id of the EntityDescriptionRef. | N |
| accountRelationship.account.href | string | Unique reference of the EntityDescriptionRef | N |
| accountRelationship.account.description | string | Detailed description of the EntityDescriptionRef | N |
| accountRelationship.account.name | string | Name of the account. | N |
| accountRelationship.account.@baseType | string | When sub-classing, this defines the super-class | N |
| accountRelationship.account.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| accountRelationship.account.@type | string | When sub-classing, this defines the sub-class entity name | N |
| accountRelationship.account.@referredType | string | The actual type of the target instance when needed for disambiguation | N |
| accountRelationship.validFor | accountBalance.validFor | 'A period of time, either as a deadline (endDateTime only) a startDateTime only, or both | N |
| accountRelationship.@baseType | string | When sub-classing, this defines the super-class | N |
| accountRelationship.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| accountRelationship.@type | string | When sub-classing, this defines the sub-class entity name | N |
| billStructure | object | The structure of the bill for party accounts (billing or settlement). | N |
| billStructure.cycleSpecification | object | An attachment by value or by reference. | N |
| billStructure.cycleSpecification.id | string | Unique identifier of the billing cycle specification. Day of Billing Codes for Liberate and Possible values are from A to Z | N |
| billStructure.cycleSpecification.href | string | Reference of the billing cycle specification | N |
| billStructure.cycleSpecification.billingDateShift | integer | An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period. | N |
| billStructure.cycleSpecification.billingPeriod | string | A billing time period. It can be recurring, for example: week, month, quarter of year, year . | N |
| billStructure.cycleSpecification.chargeDateOffset | integer | An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod | N |
| billStructure.cycleSpecification.creditDateOffset | integer | An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod | N |
| billStructure.cycleSpecification.dateShift | integer | An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period. | N |
| billStructure.cycleSpecification.description | string | An explanation regarding this billing cycle specification | N |
| billStructure.cycleSpecification.frequency | string | Frequency of the billing cycle (monthly for instance) | N |
| billStructure.cycleSpecification.mailingDateOffset | integer | An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod. | N |
| billStructure.cycleSpecification.name | string | A short descriptive name | N |
| billStructure.cycleSpecification.paymentDueDateOffset | integer | An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod. | N |
| billStructure.cycleSpecification.@baseType | string | When sub-classing, this defines the super-class | N |
| billStructure.cycleSpecification.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| billStructure.cycleSpecification.@type | string | When sub-classing, this defines the sub-class entity name | N |
| billStructure.cycleSpecification.@referredType | string | The actual type of the target instance when needed for disambiguation | N |
| billStructure.format | accountRelationship.account | An attachment by value or by reference. | N |
| billStructure.presentationMedia | accountRelationship.account | A list of bill presentation media ref or values | N |
| billStructure.presentationMedia.id | string | Unique identifier of the bill presentation media. Ex E-Email,P-Paper Bill,N-Non-Paper based bills, E-Electronic Bills | |
| billStructure.presentationMedia.name | string | A short descriptive name | |
| billStructure.@baseType | string | When sub-classing, this defines the super-class | N |
| billStructure.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| billStructure.@type | string | When sub-classing, this defines the sub-class entity name | N |
| contact | object Array | An individual or an organization used as a contact point for a given account and accessed via some contact medium. | N |
| contact.contactName | string | A displayable name for that contact | N |
| contact.contactType | string | Type of contact (primary, secondary...) | N |
| contact.partyRoleType | string | Identifies what kind of party role type is linked to the contact (a account manager...). | N |
| contact.contactMedium | Array | Indicates the contact medium that could be used to contact the party. | N |
| contact.contactMedium.mediumType | string | Type of the contact medium, such as: email address, telephone number, postal address, BillingAddress | N |
| contact.contactMedium.preferred | boolean | If true, indicates that is the preferred contact medium. NA for JM | N |
| contact.contactMedium.characteristic | object | Any additional characteristic(s) of this contact medium | N |
| contact.contactMedium.characteristic.city | string | City | N |
| contact.contactMedium.characteristic.contactType | string | The type of contact, for example; phone number such as mobile, fixed home, fixed office. postal address such as shipping installation | N |
| contact.contactMedium.characteristic.country | string | N | |
| contact.contactMedium.characteristic.emailAddress | string | Full email address in standard format | N |
| contact.contactMedium.characteristic.faxNumber | string | The fax number of the contact | N |
| contact.contactMedium.characteristic.phoneNumber | string | The primary phone number of the contact | N |
| contact.contactMedium.characteristic.postCode | string | Postcode | N |
| contact.contactMedium.characteristic.socialNetworkId | string | Identifier as a member of a social network | N |
| contact.contactMedium.characteristic.stateOrProvince | string | State or province | N |
| contact.contactMedium.characteristic.street1 | string | Describes the street | N |
| contact.contactMedium.characteristic.street2 | string | Complementary street description | N |
| contact.contactMedium.characteristic..@baseType | string | When sub-classing, this defines the super-class | N |
| contact.contactMedium.characteristic..@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| contact.contactMedium.characteristic..@type | string | When sub-classing, this defines the sub-class entity name | N |
| contact.contactMedium.validFor | accountRelationship.validFor | N | |
| contact.contactMedium.@baseType | string | When sub-classing, this defines the super-class | N |
| contact.contactMedium.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| contact.contactMedium.@type | string | When sub-classing, this defines the sub-class entity name | N |
| contact.relatedParty | relatedParty | N | |
| contact.validFor | accountRelationship.validFor | N | |
| contact.@baseType | string | When sub-classing, this defines the super-class | N |
| contact.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| contact.@type | string | When sub-classing, this defines the sub-class entity name | N |
| creditLimit | object | The maximum amount of money that may be charged on an account | N |
| creditLimit.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | |
| creditLimit.value | number | A floating point number | |
| defaultPaymentMethod | object | N | |
| defaultPaymentMethod.id | string | Unique identifier Id of the EntityRef. E-Electronic else C-Cash | N |
| defaultPaymentMethod.href | string | Unique reference of the EntityRef | N |
| defaultPaymentMethod.name | string | Name of the EntityRef. | N |
| defaultPaymentMethod.@baseType | string | When sub-classing, this defines the super-class | N |
| defaultPaymentMethod@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| defaultPaymentMethod.@type | string | When sub-classing, this defines the sub-class entity name | N |
| defaultPaymentMethod.@referredType | string | The actual type of the target instance when needed for disambiguation | N |
| financialAccount | object | AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An account receivable aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party. | N |
| financialAccount.id | string | Unique identifier Id of the EntityRef. | N |
| financialAccount.href | string | Unique reference of the EntityRef | N |
| financialAccount.name | string | Name of the EntityRef. | N |
| financialAccount.accountBalance | accountBalance | N | |
| financialAccount.@baseType | string | When sub-classing, this defines the super-class | N |
| financialAccount@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| financialAccount.@type | string | When sub-classing, this defines the sub-class entity name | N |
| financialAccount.@referredType | string | The actual type of the target instance when needed for disambiguation | N |
| paymentPlan | object Array | Defines a plan for payment (when a party wants to spread his payments) | N |
| paymentPlan.numberOfPayments | integer | Number of payments used to spread the global payment | N |
| paymentPlan.paymentFrequency | string | Frequency of the payments, such as monthly and bimonthly | N |
| paymentPlan.planType | string | Type of payment plan | N |
| paymentPlan.priority | integer | Priority of the payment plan. | N |
| paymentPlan.status | string | Status of the payment plan (effective, ineffective) | N |
| paymentPlan.paymentMethod | defaultPaymentMethod | N | |
| paymentPlan.totalAmount | accountBalance.amount | Amount paid | N |
| paymentPlan.validFor | accountRelationship.validFor | N | |
| paymentPlan.@baseType | string | When sub-classing, this defines the super-class | N |
| paymentPlan.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| paymentPlan.@type | string | When sub-classing, this defines the sub-class entity name | N |
| characteristic | object Array | Describes a given characteristic of an object or entity through a name/value pair. | N |
| characteristic.name | string | Name of the characteristic. "DelinquencyDays" and "DunningGroup" are added as characteristics name/value pair. | N |
| characteristic.valueType | string | Data type of the value of the characteristic | N |
| characteristic.value | any | The value of the characteristic | N |
| characteristic.@baseType | string | When sub-classing, this defines the super-class | N |
| characteristic.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| characteristic.@type | string | When sub-classing, this defines the sub-class entity name | N |
| relatedParty | object Array | N | |
| relatedParty.id | string | Unique identifier Id of the EntityRef. | N |
| relatedParty.href | string | Unique reference of the EntityRef | N |
| relatedParty.name | string | Name of the EntityRef. | N |
| relatedParty.role | role played by the related party | N | |
| relatedParty.@baseType | string | When sub-classing, this defines the super-class | N |
| relatedParty@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| relatedParty.@type | string | When sub-classing, this defines the sub-class entity name | N |
| relatedParty.@referredType | string | The actual type of the target instance when needed for disambiguation | N |
| taxExemption | object Array | Proof of freedom from taxes imposed by a taxing jurisdiction. | N |
| taxExemption.certificateNumber | string | Identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction. | N |
| taxExemption.issuingJurisdiction | string | Name of the taxing jurisdiction for which taxes are exempt. | N |
| taxExemption.reason | string | Reason of the tax exemption | N |
| taxExemption.validFor | accountRelationship.validFor | N | |
| taxExemption.@baseType | string | When sub-classing, this defines the super-class | N |
| taxExemption.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| taxExemption.@type | string | When sub-classing, this defines the sub-class entity name | N |
| @baseType | string | When sub-classing, this defines the super-class | N |
| @schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| @type | string | When sub-classing, this defines the sub-class entity name | N |